/*
 * Copyright 2012-2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.autoconfigure.condition;

import java.lang.annotation.Annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.context.annotation.Conditional;

/**
 * {@link Conditional @Conditional} 注解，仅当 {@link BeanFactory} 中已包含满足所有指定条件的 Bean 时匹配。
 * 所有条件必须满足才能匹配，但不必由同一个 Bean 满足。
 * <p>
 * 当用于 {@code @Bean} 方法时，Bean 类默认为工厂方法的返回类型：
 *
 * <pre class="code">
 * &#064;Configuration
 * public class MyAutoConfiguration {
 *
 *     &#064;ConditionalOnBean
 *     &#064;Bean
 *     public MyService myService() {
 *         ...
 *     }
 *
 * }</pre>
 * <p>
 * 上例中，条件在 {@link BeanFactory} 中已包含类型为 {@code MyService} 的 Bean 时匹配。
 * <p>
 * 此条件仅匹配应用上下文迄今为止处理过的 Bean 定义，因此强烈建议仅在自动配置类中使用该条件。
 * 如果候选 Bean 可能由其他自动配置创建，确保使用此条件的自动配置在其之后执行。
 *
 * @author Phillip Webb
 * @since 1.0.0
 */
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnBeanCondition.class)
public @interface ConditionalOnBean {

	/**
	 * 应检查的 Bean 的类类型。当所有指定的类类型的 Bean 都存在于 {@link BeanFactory} 时，条件匹配。
	 * @return 要检查的 Bean 类类型数组
	 */
	Class<?>[] value() default {};

	/**
	 * 应检查的 Bean 的类类型名称。当所有指定的类名称的 Bean 都存在于 {@link BeanFactory} 时，条件匹配。
	 * @return 要检查的 Bean 类类型名称数组
	 */
	String[] type() default {};

	/**
	 * 用于装饰 Bean 的注解类型。当所有指定注解都存在于 {@link BeanFactory} 中的 Bean 上时，条件匹配。
	 * @return 要检查的类级注解类型数组
	 */
	Class<? extends Annotation>[] annotation() default {};

	/**
	 * 要检查的 Bean 名称。当所有指定的 Bean 名称都存在于 {@link BeanFactory} 时，条件匹配。
	 * @return 要检查的 Bean 名称数组
	 */
	String[] name() default {};

	/**
	 * 决定是否考虑应用上下文层级（父上下文）的策略。
	 * @return 搜索策略
	 */
	SearchStrategy search() default SearchStrategy.ALL;

	/**
	 * 可能包含指定 Bean 类型的额外泛型容器类。
	 * 例如，注解声明 {@code value=Name.class} 和 {@code parameterizedContainer=NameRegistration.class}，
	 * 将同时检测 {@code Name} 和 {@code NameRegistration<Name>}。
	 * @return 泛型容器类型数组
	 * @since 2.1.0
	 */
	Class<?>[] parameterizedContainer() default {};

}
